home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Users Group Library 1996 July / C-C++ Users Group Library July 1996.iso / vol_100 / 157_01 / qedpc.doc < prev    next >
Text File  |  1987-10-10  |  23KB  |  510 lines
  1. QED VERSION:        1.22
  2. LAST COMPILE DATE:    15 DECEMBER 1987
  3. DOCUMENTATION DATE:    13 APRIL 1987
  4. PCDOS VERSION:          2.1 AND HIGHER
  5. AUTHORS:              Nigel Gilbert and James Haefner
  6.  
  7. ---------------------------------------------------------------------
  8. TABLE OF CONTENTS
  9.  
  10. I.    GENERAL DESCRIPTION
  11. II.   HOW TO RUN QED WITHOUT READING THE MANUAL
  12. III.  COMMAND LINE INVOCATION
  13. IV.   DEFINITION OF CONTROL KEYS
  14.       A.  CURSOR MOVEMENT
  15.       B.  BLOCK MOVES (Save, Exit, Move text)
  16.       C.  DELETIONS
  17.       D.  "QUICK" MOVES (Find/Alter, Defaults, File manipulation)
  18.       E.  PARAGRAPH REFORM
  19.       F.  VERSION DOCUMENTATION
  20. V.    TRICKS
  21.       A.  UNDO
  22.       B.  INSERTING ESCAPE SEQUENCES INTO TEXT
  23.       C.  EDITING SEARCH LINES
  24.       D.  DEFAULT FILE EXTENSIONS
  25.       E.  JUMPS
  26.       F.  MARKING TEXT
  27. VI.   BUGS
  28. VII.  TABLE OF CONTROL CHARACTERS
  29. ---------------------------------------------------------------------
  30.  
  31. I.   GENERAL DESCRIPTION
  32.  
  33.      QED is a public domain editor originally written in C by 
  34. Nigel Gilbert of England.  His version was written in BDS C 
  35. (trademark) for microcomputers running CP/M versions 2.x and 3.0.  
  36. The original Gilbert version is available from the C User's Group 
  37. (McPherson, Kansas).  I (J. Haefner) made major modifications to 
  38. this original code for CP/M, ported these modifications to MSDOS and
  39. PCDOS.  QED comes in a variety of flavors depending on the target 
  40. computer; QEDPC is the version that runs on IBM-PCs and compatibles.  
  41. Below, QED and QEDPC are synonymous.
  42.  
  43.      QED is a full-screen editor that it attempts to duplicate the 
  44. user interface of WordStar (tm) as closely as possible, with 
  45. "improvements" as I have seen fit.  (As a full- screen editor, it 
  46. bears no resemblence to line editors such as EDLIN or SOS.)  There 
  47. are no "modes" in the sense of some screen editors in which one must 
  48. explicitly choose a "command" mode or a "input" mode.  In QED, one 
  49. is always in an "input" mode; commands to the editor that are not 
  50. text to be inserted in the file are keyed in as control characters 
  51. (i.e., characters transmitted by typing the "control key" and 
  52. certain alphabetic and punctuation keys simultaneously, usually 
  53. symbolized as ^x, where x is a character, e.g., ^C). 
  54.  
  55.      QED is intended primarily as an editor for creating programs or 
  56. keying in numerical data.  As such, it has some features of interest 
  57. to programmers and lacks many features of word processors.  
  58. Obviously, it can also be used to create files of text to be sent to 
  59. a text formatter such as RUNOFF.  For the programmers, QED has 
  60. auto-indent, "jump to" a line, an extensive list of command line 
  61. options, search and replace, reformatting of indented program text, 
  62. and an "expert" mode.  It also has automatic word-wrap at a 
  63. prescribed screen column setting and the ability to reform 
  64. paragraphs to fit within a prescribed column setting.   It lacks, 
  65. alas, right justification, and printing formatting facilities.  QED 
  66. produces "straight ASCII" files, i.e., files containing no special 
  67. formatting codes or printing control character sequences.  As a 
  68. result, QED is well-suited for creating files required by other 
  69. applications or programs (e.g., OMNIPLOT plotting package, data 
  70. entry for statistical programs, etc.). 
  71.  
  72.  
  73. II.  HOW TO RUN QED WITHOUT READING THE MANUAL
  74.  
  75.      1.   QEDPC occupies only 37K of disk space, so it can easily 
  76. reside on any disk, drive A or B.
  77.  
  78.      2.   If you are a beginner, you will want the non-expert 
  79. mode and the on-screen help to be permanently displayed.  
  80. Assuming this, invoke QEDPC to begin a new file with:
  81.  
  82.           A>QEDPC -E -V
  83.  
  84. (The "A>" is the PCDOS prompt indicating drive A as the default 
  85. drive, of course.)  This will present you with a status line at the 
  86. top of the screen, about 6 lines of help messages, and the cursor 
  87. over the point at which text may be inserted. 
  88.  
  89.      3.   Insert text by typing any of the printable ASCII 
  90. characters.  Hit the "RETURN" key at the end of each line (no 
  91. automatic word-wrap).
  92.  
  93.      4.   To save the text as a file type ^K (CTRL and K  
  94. simultaneously).  This will prompt you with a verbose, but 
  95. informative instruction.  To save the text and leave QEDPC, respond 
  96. with Q, then W (after the prompt), then the file name (after the 
  97. prompt), then E (after the prompt).  In short, the sequence is 
  98. ^KQWE.
  99.  
  100.      5.   To edit an existing file invoke QEDPC this way:
  101.  
  102.           A>QEDPC filename -E -V
  103.  
  104.           This will display a message reminding you of the name 
  105. of the program you just typed, followed, after clearing the 
  106. screen, by the first 23 lines of text of the file.  QEDPC cannot 
  107. distinguish text files from non-text files; therefore, garbage 
  108. will appear if you attempt to edit an EXE file, or any other non-text 
  109. file.
  110.  
  111.      6.   To move around in the file, type the control characters 
  112. as indicated on the on-screen help (^QO), and as more fully described 
  113. below (in the manual!).  QEDPC has no "overwrite" mode, one is 
  114. always inserting text, pushing existing text ahead of the cursor.  
  115. Explicit deletion is required to remove this text.  Exiting the 
  116. editing session is the same as above.
  117.  
  118.  
  119. III. COMMAND LINE INVOCATION
  120.  
  121.      The official syntax of QEDPC 1.22 is:
  122.  
  123. QEDPC [-Jn -A -B -L -H -R -Mn -Tn -S -U -V -E -X -Dd [filename1 [filename2]]]
  124.  
  125. "[]" indicates optional input.  "Filename1" is an optional file 
  126. which QEDPC is to read in and "filename2" is an optional file to 
  127. which QEDPC is to save any editing changes made.  If "filename2" is 
  128. absent, "filename1" is used.  Each letter in the command line is an 
  129. option that configures the "context" or "environment" of the current 
  130. editing session.  They have the following meanings and defaults []: 
  131.  
  132.  
  133.           -Jn:  Jump to line n [1]
  134.           -A :  Autoindent on carriage return [YES]
  135.           -B :  Make backup file on exit (filename.bak) [YES]
  136.           -L :  Show line and column on statusline [YES]
  137.           -H :  Horizontal scroll entire screen [NO]
  138.           -R :  Read entire file on initial load [YES]
  139.           -Mn:  Margin (right) set to n [255]
  140.           -Tn:  Set tabwidth to n [4]
  141.           -S :  Strip trailing blanks and tabs [YES]
  142.           -U :  Update version and date [YES]
  143.           -V :  Display onscreen help [NO]
  144.           -E :  Expert (terse) mode [YES]
  145.           -X :  Warm boot on exit [YES]
  146.           -Dd:  Drive d for temporary paging files [current]
  147.  
  148. Options and filename1 may occur in any order; filename2 must 
  149. follow filename1.  Upper and lower case may be used in any 
  150. combination.
  151.  
  152.      Examples:
  153.  
  154.      QEDPC -j400 -e -T8 FOO.BAR foo2.bar
  155.  
  156.      This will invoke the version of QEDPC, will turn the expert 
  157. mode off (-e), set the tabs to 8 spaces (-T8), read from FOO.BAR and 
  158. write to FOO2.BAR, and jump to line 400 (-j400). 
  159.  
  160.      QEDPC
  161.  
  162.      This will load QEDPC and present the user with a blank screen 
  163. for data input. 
  164.  
  165.  
  166. IV.  DEFINITION OF CONTROL KEYS
  167.  
  168.      A complete map of the functions of all control keys (^x) 
  169. is at the end of this documentation.  Two (^Q and ^K) have no 
  170. immediate effect, but prompt for more command input (see below).
  171. Typing ESC (escape key) at a prompt will cancel the request and
  172. usually returns the cursor to the text being edited.
  173.  
  174.      A.   CURSOR MOVEMENT
  175.  
  176.      Cursor movement is controlled using control characters.  The 
  177. association of function with control key follows, in general, the 
  178. pattern of WordStar (tm).  For the most part, the function of 
  179. control keys reachable from the left hand is identical to 
  180. WordStar:  the keys A-E-F-X form a diamond where the top of the 
  181. diamond produces movement upwards, the left-side produces 
  182. leftward movement, and so on.   Vertical scrolling which leaves 
  183. the cursor in place is implemented via ^W (scroll up through 
  184. file) and ^Z (down).  ^Y and ^V moves the cursor to the top and 
  185. bottom, respectively, of the screen.  ^U and ^B moves the cursor 
  186. to the top and bottom, respectively, of the file.  Thus, for the 
  187. left side of the keyboard there exists a relatively uniform and 
  188. mnemonic mapping of ke